<HTML>
<HEAD>
   <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
   <META NAME="Author" CONTENT="Michael Wetter">
   <TITLE>GenOpt Readme Note</TITLE>
   <LINK REL ="stylesheet" TYPE="text/css" HREF="../../documentation/jdoc/jstyle.css" TITLE="Style">
</HEAD>
<!-- ========================================================== -->
<BODY>
<H1>GenOpt Examples for EnergyPlus</H1>
<P>
This directory contains example files that illustrate the use 
of GenOpt in conjunction with the EnergyPlus simulation program.
</p>
<h4>Information for EnergyPlus, versions 7.0.0 or later</h4>
<p>
Due to changes in the EnergyPlus <code>*.eso</code> file format,
it is now required to specify in the optimization initialization file,
section <code>ObjectiveFunctionLocation</code>
the entries
<code>FirstCharacterAti</code> (i=1, 2, ...).
For example, a specification may now look like
<pre>
 Name1             = Q_heat;
 Delimiter1       = "170,";
 FirstCharacterAt1 = 1;
 
 Name2             = Q_cool;
 Delimiter2        = "201,";
 FirstCharacterAt2 = 1;
</pre>
Without the keyword <code>FirstCharacterAti</code>,
the wrong numbers may be read from the EnergyPlus <code>*.eso</code> file.
</p>
<p>
See the GenOpt manual for a description of this keyword.
</p>
<h4>Information for EnergyPlus on Windows, versions 5.0.1 or later</h4>
<p>
Because the Windows PATH variable does not contain the installation
directory of EnergyPlus, the path to the EnergyPlus directory is
hardcoded in the file <code>"genopt_installation_dir"\cfg\EnergyPlus-*-Win*.cfg</code>.
Depending on your EnergyPlus installation, you may need to update in the file
<code>"genopt_installation_dir"\cfg\EnergyPlus-*-Win*.cfg</code>
the entry
<code>C:\\Program Files \(x86\)\\EnergyPlusV7-0-0\\RunEPlus.bat</code> 
to point to the EnergyPlus directory that contains the file <code>RunEPlus.bat</code>.
</p>
<h4>Information for EnergyPlus on Windows, versions prior to 5.0.1</h4>
<p>
Because the Windows version of EnergyPlus writes its output files to 
the folder 
<tt>C:\Program Files\EnergyPlus\ExampleFiles\Outputs\</tt>,
it was necessary to change the file <tt>RunEPlus.bat</tt> 
that is part of the EnergyPlus distribution. The changes allow 
GenOpt to run multiple EnergyPlus simulations in parallel.
The modified file, called <tt>RunEPlusParallel.bat</tt> ensures
that each simulation writes its output files to its own working directory,
which is generated by GenOpt for each simulation.
Typically, users do not have to modify any files because
the GenOpt simulation configuration file <tt>(cfg\EnergyPlusWinXP.cfg)</tt>
will cause GenOpt to start <tt>RunEPlusParallel.bat</tt> instead of
<tt>RunEPlus.bat</tt>. 
</p>
<p>
If you make a new directory with GenOpt and EnergyPlus input files,
you will need to copy <tt>RunEPlusParallel.bat</tt> to this directory
so it can be invoked by GenOpt.
</p>
<p>
For further information, please consult the GenOpt manual 
and the EnergyPlus manual.
</p>
<!-- ========================================================== -->
<DIV CLASS="FOOTER">
<P>
<HR WIDTH=100%>
Please send comments or questions to
Michael Wetter, LBNL, <A HREF="mailto:MWetter@lbl.gov">MWetter@lbl.gov</A>
<BR>
November 30, 2011.
</DIV>
</BODY>
</HTML>
